From ff6cbadee69380caa81a97fdee7568ef5c737be6 Mon Sep 17 00:00:00 2001 From: Behnam Esfahbod Date: Fri, 1 Sep 2017 15:31:37 -0700 Subject: [PATCH] [doc/book] Drop reference/policies.md and small fixes We don't need to put `policies.md` in the book. See for more. Renaming `introduction.md` to `index.md` prevents creating two html files (and URL) for one source. The rest are small styling issues. Tracker: --- src/doc/book/src/SUMMARY.md | 3 +- .../book/src/{introduction.md => index.md} | 0 src/doc/book/src/reference/external-tools.md | 7 +- src/doc/book/src/reference/pkgid-spec.md | 16 ++-- src/doc/book/src/reference/policies.md | 70 ------------------ .../{src/favicon.ico => theme/favicon.png} | Bin src/doc/external-tools.md | 7 +- src/doc/pkgid-spec.md | 16 ++-- 8 files changed, 25 insertions(+), 94 deletions(-) rename src/doc/book/src/{introduction.md => index.md} (100%) delete mode 100644 src/doc/book/src/reference/policies.md rename src/doc/book/{src/favicon.ico => theme/favicon.png} (100%) diff --git a/src/doc/book/src/SUMMARY.md b/src/doc/book/src/SUMMARY.md index 858c64b44..ff388e770 100644 --- a/src/doc/book/src/SUMMARY.md +++ b/src/doc/book/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -[Introduction](introduction.md) +[Introduction](index.md) * [Getting Started](getting-started.md) * [Installation](getting-started/installation.md) @@ -26,6 +26,5 @@ * [Package ID Specifications](reference/pkgid-spec.md) * [Source Replacement](reference/source-replacement.md) * [External Tools](reference/external-tools.md) - * [Crates.io Package Policies](reference/policies.md) * [FAQ](faq.md) diff --git a/src/doc/book/src/introduction.md b/src/doc/book/src/index.md similarity index 100% rename from src/doc/book/src/introduction.md rename to src/doc/book/src/index.md diff --git a/src/doc/book/src/reference/external-tools.md b/src/doc/book/src/reference/external-tools.md index 38ae530b4..0ba2c5186 100644 --- a/src/doc/book/src/reference/external-tools.md +++ b/src/doc/book/src/reference/external-tools.md @@ -4,10 +4,11 @@ One of the goals of Cargo is simple integration with third-party tools, like IDEs and other build systems. To make integration easier, Cargo has several facilities: -* `cargo metadata` command, which outputs project structure and dependencies +* a `cargo metadata` command, which outputs project structure and dependencies information in JSON, -* `--message-format` flag, which outputs information about a particular build, +* a `--message-format` flag, which outputs information about a particular build, + and * support for custom subcommands. @@ -85,7 +86,7 @@ Information about dependencies in the Makefile-compatible format is stored in the `.d` files alongside the artifacts. -### Custom subcommands. +### Custom subcommands Cargo is designed to be extensible with new subcommands without having to modify Cargo itself. This is achieved by translating a cargo invocation of the form diff --git a/src/doc/book/src/reference/pkgid-spec.md b/src/doc/book/src/reference/pkgid-spec.md index 6365c397c..bd7ac2d92 100644 --- a/src/doc/book/src/reference/pkgid-spec.md +++ b/src/doc/book/src/reference/pkgid-spec.md @@ -27,14 +27,14 @@ Here, brackets indicate that the contents are optional. These could all be references to a package `foo` version `1.2.3` from the registry at `crates.io` -| pkgid | name | version | url | -|-------------------------------:|:------:|:---------:|:--------------------:| -| `foo` | foo | * | * | -| `foo:1.2.3` | foo | 1.2.3 | * | -| `crates.io/foo` | foo | * | *://crates.io/foo | -| `crates.io/foo#1.2.3` | foo | 1.2.3 | *://crates.io/foo | -| `crates.io/bar#foo:1.2.3` | foo | 1.2.3 | *://crates.io/bar | -| `http://crates.io/foo#1.2.3` | foo | 1.2.3 | http://crates.io/foo | +| pkgid | name | version | url | +|:-----------------------------|:-----:|:-------:|:----------------------:| +| `foo` | `foo` | `*` | `*` | +| `foo:1.2.3` | `foo` | `1.2.3` | `*` | +| `crates.io/foo` | `foo` | `*` | `*://crates.io/foo` | +| `crates.io/foo#1.2.3` | `foo` | `1.2.3` | `*://crates.io/foo` | +| `crates.io/bar#foo:1.2.3` | `foo` | `1.2.3` | `*://crates.io/bar` | +| `http://crates.io/foo#1.2.3` | `foo` | `1.2.3` | `http://crates.io/foo` | #### Brevity of specifications diff --git a/src/doc/book/src/reference/policies.md b/src/doc/book/src/reference/policies.md deleted file mode 100644 index 9d48d095f..000000000 --- a/src/doc/book/src/reference/policies.md +++ /dev/null @@ -1,70 +0,0 @@ -## Crates.io Package Policies - -In general, these policies are guidelines. Problems are often contextual, and -exceptional circumstances sometimes require exceptional measures. We plan to -continue to clarify and expand these rules over time as new circumstances -arise. If your problem is not described below, consider [sending us an email]. - -### Package Ownership - -We have a first-come, first-served policy on crate names. Upon publishing a -package, the publisher will be made owner of the package on Crates.io. - -If someone wants to take over a package, and the previous owner agrees, the -existing maintainer can add them as an owner, and the new maintainer can remove -them. If necessary, the team may reach out to inactive maintainers and help -mediate the process of ownership transfer. - -### Removal - -Many questions are specialized instances of a more general form: “Under what -circumstances can a package be removed from Crates.io?” - -The short version is that packages are first-come, first-served, and we won’t -attempt to get into policing what exactly makes a legitimate package. We will -do what the law requires us to do, and address flagrant violations of the Rust -Code of Conduct. - -### Squatting - -We do not have any policies to define 'squatting', and so will not hand over -ownership of a package for that reason. - -### The Law - -For issues such as DMCA violations, trademark and copyright infringement, -Crates.io will respect Mozilla Legal’s decisions with regards to content that -is hosted. - -### Code of Conduct - -The Rust project has a [Code of Conduct] which governs appropriate conduct for -the Rust community. In general, any content on Crates.io that violates the Code -of Conduct may be removed. Here, content can refer to but is not limited to: - -- Package Name -- Package Metadata -- Documentation -- Code - -There are two important, related aspects: - -- We will not be pro-actively monitoring the site for these kinds of violations, - but relying on the community to draw them to our attention. -- “Does this violate the Code of Conduct” is a contextual question that - cannot be directly answered in the hypothetical sense. All of the details - must be taken into consideration in these kinds of situations. - -# Security - -Cargo and crates.io are projects that are governed by the Rust Programming -Language Team. Safety is one of the core principles of Rust, and to that end, -we would like to ensure that cargo and crates.io have secure implementations. -To learn more about disclosing security vulnerabilities, please reference the -[Rust Security policy] for more details. - -Thank you for taking the time to responsibly disclose any issues you find. - -[Rust Security policy]: https://www.rust-lang.org/security.html -[Code of Conduct]: https://www.rust-lang.org/conduct.html -[sending us an email]: mailto:help@crates.io diff --git a/src/doc/book/src/favicon.ico b/src/doc/book/theme/favicon.png similarity index 100% rename from src/doc/book/src/favicon.ico rename to src/doc/book/theme/favicon.png diff --git a/src/doc/external-tools.md b/src/doc/external-tools.md index d45e4cf64..8afb762fe 100644 --- a/src/doc/external-tools.md +++ b/src/doc/external-tools.md @@ -4,10 +4,11 @@ One of the goals of Cargo is simple integration with third-party tools, like IDEs and other build systems. To make integration easier, Cargo has several facilities: -* `cargo metadata` command, which outputs project structure and dependencies +* a `cargo metadata` command, which outputs project structure and dependencies information in JSON, -* `--message-format` flag, which outputs information about a particular build, +* a `--message-format` flag, which outputs information about a particular build, + and * support for custom subcommands. @@ -85,7 +86,7 @@ Information about dependencies in the Makefile-compatible format is stored in the `.d` files alongside the artifacts. -# Custom subcommands. +# Custom subcommands Cargo is designed to be extensible with new subcommands without having to modify Cargo itself. This is achieved by translating a cargo invocation of the form diff --git a/src/doc/pkgid-spec.md b/src/doc/pkgid-spec.md index 11522f489..a2d6a067e 100644 --- a/src/doc/pkgid-spec.md +++ b/src/doc/pkgid-spec.md @@ -27,14 +27,14 @@ Here, brackets indicate that the contents are optional. These could all be references to a package `foo` version `1.2.3` from the registry at `crates.io` -| pkgid | name | version | url | -|-------------------------------:|:------:|:---------:|:--------------------:| -| `foo` | foo | * | * | -| `foo:1.2.3` | foo | 1.2.3 | * | -| `crates.io/foo` | foo | * | *://crates.io/foo | -| `crates.io/foo#1.2.3` | foo | 1.2.3 | *://crates.io/foo | -| `crates.io/bar#foo:1.2.3` | foo | 1.2.3 | *://crates.io/bar | -| `http://crates.io/foo#1.2.3` | foo | 1.2.3 | http://crates.io/foo | +| pkgid | name | version | url | +|:-----------------------------|:-----:|:-------:|:----------------------:| +| `foo` | `foo` | `*` | `*` | +| `foo:1.2.3` | `foo` | `1.2.3` | `*` | +| `crates.io/foo` | `foo` | `*` | `*://crates.io/foo` | +| `crates.io/foo#1.2.3` | `foo` | `1.2.3` | `*://crates.io/foo` | +| `crates.io/bar#foo:1.2.3` | `foo` | `1.2.3` | `*://crates.io/bar` | +| `http://crates.io/foo#1.2.3` | `foo` | `1.2.3` | `http://crates.io/foo` | ## Brevity of specifications -- 2.30.2